/*
 * #%L
 * InterfaceAPI
 * %%
 * Copyright (C) 2011 Ractoc.com
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package com.ractoc.opengamefinder.api.messages;

import com.ractoc.pffj.api.BasePluginMessage;

/**
 * This message tells the GUI plugin to display an error message. Error messages
 * are coded as integers. This is to ensure the actually displayed text can be
 * easily changed depending on the language chosen by the player.
 * 
 * @author ractoc
 * @version 0.1
 */
public final class ErrorMessage extends BasePluginMessage {

    private static final long serialVersionUID = 5762249585432381031L;

    private Enum errorCode;

    /**
     * Default constructor.
     */
    public ErrorMessage() {
    }

    /**
     * Get the errorcode.
     * @return The error code.
     */
    public Enum getErrorCode() {
        return errorCode;
    }

    /**
     * Set the error code.
     * @param errorCodeParam The error code.
     */
    public void setErrorCode(final Enum errorCodeParam) {
        this.errorCode = errorCodeParam;
    }

}
